Skip to main content

Code Standard

Penulisan nama function, variable, class, id, dan lainya​

Penulian nama function, variable, class, id, dan lainya harus Jelas dan berbahasa Inggris. Dan harus diawali huruf kecil, kata selanjutnya huruf besar, dan tidak boleh pakai angka atau simbol terkecuali underscor didepan _sampleFunction(). Jerkecuali jika penulisan class diawali huruf besar dan tidak boleh ada character atau angka dimanapun

function.js
function wadaw() { // ==> penuliasan 'wadaw' atau kata asal lainya dilarang
  // YOUR CODE
}

function x() { // ==> penuliasan 'x' atau kata ambigu lainya dilarang
  // YOUR CODE
}

function tambahPesanan() { // ==> penuliasan menggunakan bahasa indonesia dilarang
  // YOUR CODE
}

function submitOrder() { // ==> Bagus, boleh juga _submitOrder()
  // YOUR CODE
}
variable.js
let x = 0; // ==> penuliasan 'x' atau kata ambigu lainya dilarang
let wadaw = 0; // ==> penuliasan 'wadaw' atau kata asal lainya dilarang
let totalHarga = 0; // ==> penuliasan menggunakan bahasa indonesia dilarang
let totalPrice = 0; //  ==> Bagus, boleh juga _totalPrice

...
class.js
class _ApiService2(){ // => dilarang menggunakan angka dan character
  // YOUR CODE
}

class apiService(){ // ==> dilarang, huruf pertama harus capital
  // YOUR CODE
}

class ApiService(){ // ==> Sesuai Prosedur
  // YOUR CODE
}

untuk penulian id, class di css menggunakan **huruf kecil semua dan tanda (-) sebagai pemisah kata

id.html
<input type='text' id='input-username' class='input-username-rounded' placeholder="Username">
classdanid.css
.input-username-rounded {
  ...
}

#input-username {
  ...
}

Penggunaan function untuk kebutuhan debugging​

Penggunaan function untuk kenutuhan debuging seperti console.log() dibolehkan, tetapi harus dihapus ketika mau push ke github atau di deploy

Penggunaan Comment​

Penggunaan comment dibolehkan jika itu memenuhi standar dan untuk sebagai penanda. untuk lebih jelasnya contoh dibawah :

Dilarang

methods: {
  // enggunaan comment dibolehkan jika itu memenuhi standar dan untuk sebagai penanda. untuk lebih jelasnya contoh dibawah : =>  Koment terlalu panjang juga dilarang
  submitOrder(){
    apiService('URL').then(res =>{
      // const data = {res}
      // this.dataList = data  ==> comment yang dilarang
      // this.loading = false
      ...
    }).catch(err=>{
      ...
    })
  }
}

Dibolehkan

methods: {
  // Submit Order ==> dibolehkan
  submitOrder(){
    apiService('URL').then(res =>{
      const data = {res}
      this.dataList = data  ==> comment yang dilarang
      this.loading = false
      ...
    }).catch(err=>{
      ...
    })
  }
}

Penulisan Nama File​

untuk penulisan nama file harus menggunakan nama fitur format sebagai berikut:

NamaFile.parentfolder.extention

misal di folder routes

`auth.routes.js`

Penulisan Nama Folder​

untuk penulisan nama folder harus menggunakan nama fitur format sebagai berikut:

  • misal nama fitur kendala pengiriman maka untuk penamaan folder KendalaPengiriman
catatan:
penamaan folder dilarang menggunakan simbol character maupun angka